//------------------------------------------------------------------------------
//  <copyright file="MessageTuple.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
//  </copyright>
//------------------------------------------------------------------------------

namespace Microsoft.Robotics.Runtime
{
    using System;
    using System.Collections.Generic;
    using System.Diagnostics;
    using System.Runtime.Serialization;
    using System.Threading;

    /// <summary>
    /// Represents a tuple of agent messages. This class exists in support of message join scenarios, e.g. message synchronization.
    /// </summary>
    /// <typeparam name="T1">The first type of message in the tuple.</typeparam>
    /// <typeparam name="T2">The second type of message in the tuple.</typeparam>
    [DataContract]
    public class MessageTuple<T1, T2> : AgentMessage
        where T1 : AgentMessage
        where T2 : AgentMessage
    {
        /// <summary>
        /// The first message in the tuple.
        /// </summary>
        [DataMember]
        private T1 message1;

        /// <summary>
        /// The second message in the tuple.
        /// </summary>
        [DataMember]
        private T2 message2;

        /// <summary>
        /// Initializes a new instance of the MessageTuple class.
        /// </summary>
        /// <param name="message1">The first message in the tuple.</param>
        /// <param name="message2">The second message in the tuple.</param>
        /// <param name="originatingTime">Originating times for the message</param>
        public MessageTuple(T1 message1, T2 message2, long originatingTime)
            : base(originatingTime)
        {
            this.message1 = message1;
            this.message2 = message2;
        }

        /// <summary>
        /// Gets the first message in the tuple.
        /// </summary>
        public T1 Message1
        {
            get { return this.message1; }
        }

        /// <summary>
        /// Gets the second message in the tuple.
        /// </summary>
        public T2 Message2
        {
            get { return this.message2; }
        }
    }  
}
